Методичні вказівки до лабораторної роботи № 6 “Розробка документації на програмне забезпечення” з дисципліни “Технологія програмування та створення програмних продуктів” для студентів базового напрямку підготовки по спеціальності “Комп’ютерні науки” (шифр 0804) Львів 2010 – 20011 Методичні вказівки до лабораторної роботи № 6 “Розробка документації на програмне забезпечення” з дисципліни “Технологія програмування та створення програмних продуктів” для студентів спеціальності - шифр 0804 “Комп’ютерні науки”/ Укл. доц. Ковівчак Я.В., Львів: Національний університет “Львівська політехніка”, 2011. Методичні вказівки обговорено та схвалено на засіданні кафедри АСУ Протокол № ___________ від «___»___________2011 р. Завідувач кафедрою АСУ ______________ Рашкевич Ю. М. Методичні вказівки обговорено та схвалено на засіданні методичної комісії базового напрямку підготовки Протокол № ___________ від «___»___________2011 р. Лабораторна робота № 6 Розробка документації на програмне забезпечення Мета: Ознайомитись з етапом виготовлення документації на програмний продукт. Завдання: Розробити необхідний повний перелік документації на програмне забезпечення. Теоретична Частина Документування - це важлива частина розробки програмного забезпечення, але часто їй приділяють недостатньо уваги. Документація на програмне забезпечення - це документи, що супроводжують деяке програмне забезпечення (ПЗ) - програму чи програмний продукт. Ці документи описують те, як працює програма або те, як її використовувати. Документація проекту Протягом роботи над проектом створюють велику кількість документів, наприклад: документація виробничого процесу ПЗ, керівництво, яке описує завершений проект. Документація проекту містить: Плани, оцінки, графіки роботи - документи, розроблені менеджерами. Схвалені документи - це інструкції для виробників. Звіти - документи, підготовлені супервізорами. Ці документи описують роботу і її результати. Стандарти - документи, що описують необхідні стандарти. Робочі документи - різноманітні документи з ідеями рішень. Автори можуть бути членами команди. Якщо їх схвалять, ці документи можуть стати стандартами. Повідомлення - примітки, коментарі, які використовуються для комунікації між членами команди. Стандарти документації повинні стосуватися всіх аспектів проекту. Підготовка документації ділиться на стадії: попередня документація, редагування, друк, компонування копій, внесення змін у документи. Форма і зміст повинні бути ретельно підібрані відповідальними особами. Обкладинка, зміст, структура тіла документа, індекс, словник і т.п. повинні бути встановлені згідно стандарту. Потрібно визначити механізм доступу до документації, тобто слід створити бібліотеку для документів. З удосконаленням програми буде удосконалюватися і документація. Проте старі версії документів все одно залишаться. Прикладом таких документів є: інформація про всі версії, інформація про клієнтів і версії, які вони придбали, ПЗ і апаратні вимоги до версії, інформація про компоненти (класи, об'єкти, модулі), потрібні для версії, інформація про можливі зміни версії, інформація про виявлені помилки. Документація повинна супроводжуватися відповідною інфраструктурою, в межах якої ця документація створюється. Під інфраструктурою ми розуміємо межі, формат і управління документацією. Загублені документи, записи, коментарі і додаткові зауваження можуть стати загрозою для проекту. Крім того, управління інфраструктурою під час проекту є дуже витратним у фінансовому і часовому плані. Тому відповідна інфраструктура повинна бути схвалена на початку проекту. До уваги повинні бути взяті наступні пункти: унікальна ідентифікаційна структура із заголовком, автором і номером документа; номери послідовності і опис повинні містити: тип документа, номер документа, номер версії, дата версії, стан; призначення відповідальності по виробництву документа, його схваленню, редагуванню і реєстрації; процедури введення змін; призначення відповідальних; гаранті...